home *** CD-ROM | disk | FTP | other *** search
/ Magnum One / Magnum One (Mid-American Digital) (Disc Manufacturing).iso / d19 / zlabp_11.arc / GIFT40B.ARC / GIFTEST.DOC < prev    next >
Text File  |  1991-10-29  |  9KB  |  189 lines
  1.                               GIFtest 4.0ß
  2.                   CopyRight 1991 by Dave Navarro, Jr.
  3.  
  4. What is GIFtest?
  5.  
  6.      GIFtest is a command line utility to test GIF files to make sure
  7.      they are valid.  GIFtest scans the GIF header to make sure that
  8.      all the information stored is valid, and then scans the image
  9.      it self to make sure it's all there.  If everything is found in
  10.      order, GIFtest exits without any error messages or error levels.
  11.      However, if there is a problem with the GIF, GIFtest exits with
  12.      an error message letting you know what's wrong, and exits with
  13.      an error level.
  14.  
  15.      GIFtest is also capable of letting you know if a GIF has been
  16.      GIFLITE'd, has any extra bytes left by older transfer protocols,
  17.      modifying a BBS description to include the resolution of the GIF
  18.      (ProDooor and PCBoard), and rejecting GIFs that do not meet a
  19.      minimum definable resolution.
  20.  
  21.      When GIFs are transfered from user to user, or user to BBS or BBS
  22.      to user, their protocol sends files in packet sizes ranging from
  23.      128 bytes to 4k, and when they reach the end of a file, if the
  24.      remaining bytes do not equal the packet size, the packet is "padded"
  25.      with extra charactors to make it equal to the pack size.  Unfortunately,
  26.      these bytes are not trimmed off when recieved by older protocols.  It
  27.      doesn't effect the file itself, but after several hundred file transfers,
  28.      you could end up with several hundred "K" of wasted space.  GIFtest now
  29.      automatically trims these extra bytes from GIF files.
  30.  
  31.      GIFtest also conforms 100% to the GIF87a and GIF89a standards, so
  32.      will also process GIFs that contain "extensions".  These extensions
  33.      are also tested to make sure that all the "data blocks" have the
  34.      correct lengths and are valid.
  35.  
  36. NEW: Byte trimming is instantanious and no longer causes GIFtest to test
  37.      the GIF more than once.
  38.  
  39.      To register GIFtest, please send a check or money order for $30
  40.      to:
  41.             Dave Navarro, Jr.
  42.             64-38 Admiral Ave
  43.             Middle Village, NY 11379
  44.  
  45.      Please used the enclosed ORDER.FRM file.
  46.  
  47. Acknowledgements:
  48.  
  49.      The Graphics Interchange Format(c) is the Copyright property of
  50.      Compuserve Incorporated.  GIF(sm) is a Service Mark property of
  51.      Computerve Incorporated.
  52.  
  53.      Many thanks to the following individuals who have helped with the
  54.      testing of GIFtest and whose suggestions have helped GIFtest to
  55.      grow:
  56.  
  57.         Thomas Enstall, SysOp of Hard Times BBS
  58.         Howard Ross, SysOp of a private BBS
  59.         Jerry Claxton, SysOp of Woodcreek BBS
  60.         Allen Legatzke, SysOp of Sattelite BBS
  61.         Chuck Valiceck, SysOp Suburban Software BBS
  62.         Max Bernard, SysOp of Taste BBS
  63.         Steve Rimmer, Author of "Bit-Mapped Graphics"
  64.         James Davis, Programmer
  65.  
  66. Support:
  67.  
  68.      The author can be reached through US Mail at the same address used
  69.      for registration, or through "electronic mail" left on The Bard's
  70.      Lair BBS at 718-381-3651.  The author also monitors the SHAREWARE
  71.      conference in the Intelec International Network of BBSs, and the
  72.      SHAREWARE conference in the MetroLink/RelayNet International
  73.      Network of BBSs.
  74.  
  75.      Because of the high cost of voice support, and the low cost of
  76.      GIFtest, voice support from the author is not available.  If it's
  77.      absolutely important that you recieve voice support, leave an
  78.      electronic message to the author on The Bard's Lair BBS and you
  79.      will recieve a "collect" call as soon as humanly possible.
  80.  
  81. How to use GIFtest:
  82.  
  83.     GIFtest 4.0ß has the following options:
  84.       Usage: GIFTEST filename.gif [option1] [option2] etc..
  85.          /B:n          -  BBS type
  86.                           0 - None [default]
  87.                           1 - ProDoor
  88.                           2 - PCBoard
  89.          /C:[filename] -  Use options in configuration file
  90.          /D            -  Duplicate checking using 32 bit CRC's
  91.          /E            -  Erase Invalid GIF's
  92.          /L:[filename] -  Keep a log of GIFs
  93.          /M:nnXnnXnn   -  Minimum resolution to accept
  94.          /N:n          -  Node Number (requires GIFTEST.CFG)
  95.          /P:n          -  COM port numer [1 - 4]
  96.          /R:n          -  Position of resolution in description
  97.                           0 - First word on first line
  98.                           1 - Last word on first line [default]
  99.                           2 - Last word on last line
  100.                           3 - Last line by itself
  101.          /S            -  Skip GIF testing
  102.          /T:n          -  Type of resolution used
  103.                           1 - Enclosed with brackets [default]
  104.                           2 - No brackets
  105.          /U            -  Convert description to uppercase
  106.     
  107.     To use GIFtest, just type "GIFTEST filename.gif" at the DOS prompt
  108.     and GIFtest will tell you the size of the GIF and whether or not it
  109.     passed testing.
  110.  
  111.     GIFtest will also exit with one of the following Errorlevels to
  112.     help you identify what happened in batch files, or programs that
  113.     use GIFtest (such as ZipLab).
  114.  
  115.     Result                                                        ErrorLevel
  116.     GIF passed all tests                                               0
  117.     Invalid Header or Incomplete Image                                 1
  118.     File Not Found                                                     5
  119.     Invalid Command Line Option                                        5
  120.     GIFLITE'd                  [passed all other tests]               10
  121.     Failed Minumum Resolution  [passed other tests]                   20
  122.     Duplicate CRC found        [passed other tests]                   25
  123.     HOLD directory not found   [failed min resolution, or duplicate]  40
  124.     No Description Found       [passed all other tests]               60
  125.     Unknown Error              [programmer goofed]                   255
  126.  
  127. Modifying Descriptions: /B:n
  128.  
  129.    The only feature of the original GIFtest was to place the resolution
  130.    of the GIF into the description typed by users of ProDoor where I
  131.    wanted it.  Since then, many sysops have contacted me, asking that
  132.    I allow the same time of feature for their BBS type as well.
  133.    Unfortunately, the only people to give me the necessary information
  134.    have been PCBoard SysOps, so starting with 4.0, GIFtest supports
  135.    descriptions for ProDoor and PCBoard.
  136.  
  137.    However, GIFtest doesn't know which type of BBS is running,
  138.    so you'll need to tell it with the /B parameter.
  139.     /B:0 means ignore ProDoor and PCboard descriptions, just test
  140.         the GIF
  141.     /B:1 means your running ProDoor and search for $DOOR.NAM to
  142.          modify the description
  143.     /B:2 means your running PCBoard and search for UPDESC[.N] to
  144.          modify the description
  145.  
  146.    If you use the /B:n option and GIFtest does not find the description file
  147.    or does not find the description inside the description file for the GIF
  148.    and the GIF passes all tests, GIFtest will exit with ErrorLevel 40.
  149.  
  150. Configuration File: /C:[filename]
  151.  
  152.    Some programs like ZipLab shell out to GIFtest in order to test GIF
  153.    files...however, they may not allow you to include the defaults you
  154.    want to test the GIF with.  To deal with this dilemma, GIFtest searches
  155.    the current directory, the directory GIFtest is located in, and the DOS
  156.    PATH in that order for a configuration file (default name is GIFTEST.CFG
  157.    if not specified on the command line).
  158.  
  159.    The top line of the configuration file is the DOS command line
  160.    you want to use for GIFtest.  Each line after that is the
  161.    name and location for the description file for the BBS you run
  162.    for each node.
  163.  
  164.      Example:
  165.        /E/L                       ;Erase bad GIFs, Keep a log file
  166.        C:\PRO\NODE1\$DOOR.NAM     ;location of description file for node 1
  167.        C:\PRO\NODE2\$DOOR.NAM     ;location of description file for node 2
  168.  
  169.    To get the current node number, GIFtest either expects it on the command
  170.    line [see /N], or expects to find the environment variable "PCBNODE=n"
  171.    where "n" is the node number.
  172.  
  173.    Any options found in the configuration file take precedence over command
  174.    line parameters.  If you have /B:0 on the command line, but GIFtest finds
  175.    /B:1 in the configuration file, then GIFtest will use the /B:1 option.
  176.  
  177.  
  178. Erasing bad GIFs: /E
  179.  
  180.    While GIFtest does exit with an Errorlevel to indicate the failure of a
  181.    GIF to pass all tests, some users don't with to catch these errors in a
  182.    BATch file to see if the file needs to be deleted.
  183.  
  184.    The /E option will erase any GIF not passing all of the tests.
  185.  
  186.    If GIFtest is unable to erase the GIF, it will exit with errorlevel set
  187.    to 255 (programmer goof).
  188.  
  189.